home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / spitfire / sf332.zip / SFDOOR.ZIP / SFDOOR.DOC < prev   
Text File  |  1992-03-20  |  11KB  |  266 lines
  1.                                  SFDOOR
  2.                                Version 1.0
  3.                     Copyright (C) by Mike Woltz, 1991
  4.                           Buffalo Creek Software
  5.     
  6.  
  7.     INTRODUCTION
  8.     ------------
  9.         SFDOOR is a utility written by Mike Woltz, author of SPITFIRE
  10.     Bulletin Board System.  SFDOOR is written in assembler language
  11.     which contributes to its quick execution and small file size.
  12.     SFDOOR is a utility that allows SPITFIRE Sysops to create, add
  13.     to or delete entries from SPITFIRE's SFDOOR.MNU file.  SFDOOR
  14.     also allows the Sysop to review and/or modify SFDOOR.MNU.
  15.  
  16.  
  17.     USAGE
  18.     -----
  19.        SFDOOR should be executed from SPITFIRE's home directory, where
  20.     SFDOOR.MNU is located.  If you attempt to execute SFDOOR and no
  21.     SFDOOR.MNU is found, SFDOOR.COM will display the following prompt:
  22.     
  23.     SFDOOR.MNU was not found!
  24.     Do you wish to create one? [Y/n]
  25.     
  26.     If you respond with "n", you are returned to the DOS prompt.  Pressing
  27.     Enter or responding with a "y" will display the SFDOOR menu.  If
  28.     you execute SFDOOR and a SFDOOR.MNU is found, the SFDOOR menu
  29.     is automatically displayed.
  30.     
  31.       The SFDOOR menu looks like this:
  32.  
  33.       >>>>>>>>>>> SFDOOR MENU <<<<<<<<<<<<
  34.  
  35.       <A>........Add/Change A Door Listing
  36.       <D>............Delete A Door Listing
  37.       <R>................Review SFDOOR.MNU
  38.       <S>..................Save SFDOOR.MNU
  39.       <Q>.............................Quit
  40.       
  41.       Enter Selection: 
  42.       
  43.     Each option will be discussed individually below to explain how
  44.     it works.
  45.     
  46.     <A>....Add/Change A Door Listing
  47.        
  48.        Selecting this option, produces this submenu:
  49.        
  50.          >>>>>>>>>>> SFDOOR MENU <<<<<<<<<<<<
  51.  
  52.          <A>.............Add New Door Listing
  53.          <C>..Change An Existing Door Listing
  54.  
  55.          Enter Selection:
  56.          
  57.          If for any reason, you have selected this option by
  58.          mistake, pressing the ESC key will return you to the
  59.          original SFDOOR menu.
  60.  
  61.          <A>.............Add New Door Listing
  62.  
  63.            
  64.            After selecting <A>, you are prompted to:
  65.            
  66.            Enter Door Title:
  67.            
  68.            Simply enter the title.  What you enter here will display 
  69.            on the menu as the name for this door.  You will note
  70.            that SFDOOR will automatically capitalize the first
  71.            character of each word in the title.
  72.  
  73.            After entering the title, a second menu appears:
  74.  
  75.            >>>>> DOOR SECURITY ACCESS MENU <<<<<<
  76.  
  77.            <G>..Greater Than Or Equal To Security
  78.            <L>.....Less Than Or Equal To Security
  79.            <E>..................Equal To Security
  80.           
  81.            Enter Selection:
  82.           
  83.            Selecting <G>..Greater Than Or Equal To Security will require
  84.            that only callers with security equal to or greater than
  85.            the security assigned to this door will have access to the
  86.            door.
  87.           
  88.            Selecting <L>..Less Than Or Equal To Security will require
  89.            that only callers with a security equal to or less than the
  90.            security assigned to this door will be granted access to
  91.            the door.
  92.           
  93.            Selecting <E>..Equal To Security will require that only
  94.            callers with a security equal to the security assigned
  95.            to this door will be granted access to the door.
  96.  
  97.  
  98.            The last step required for adding a door is to assign it
  99.            a security level.  SFDOOR will display the prompt:
  100.            
  101.            Enter security level:
  102.           
  103.            and it is here that you can enter any security, ranging
  104.            from 0 up to 9999.
  105.  
  106.           This completes the process required to add a door listing
  107.           to SFDOOR.MNU.  SFDOOR will display the new door listing
  108.           it has added to the SFDOOR.MNU.  An example might look
  109.           like this:
  110.          
  111.           Guess A Number,SEC>=10
  112.          
  113.           SFDOOR will also provide the following prompt:
  114.          
  115.           Your SF.BAT file will probably 
  116.           need to be altered accordingly!
  117.          
  118.           as a reminder that the commands required to execute the
  119.           door must still be set up in your SF.BAT file.
  120.  
  121.  
  122.           It should also be noted that if you attempt to add a door, and
  123.           your SFDOOR.MNU contains the maximum amount of doors allowed
  124.           by SPITFIRE (24), the following prompt will display:
  125.          
  126.           Your maximum amount of door
  127.           listings are already in use!
  128.  
  129.  
  130.           <C>..Change An Existing Door Listing
  131.  
  132.           When you select this option, SFDOOR will display the following
  133.           prompt:
  134.          
  135.           Change which door listing? [A B C D E F]
  136.          
  137.           where [A B C D E F] represents the list of doors and your selection
  138.           should correspond to the door you wish to modify.  [A B C D E F]
  139.           is variable according to the number of doors you have available
  140.           on your system.  If you have the maximum number of doors this 
  141.           would range from A to Z, with the exception of G and Q.
  142.          
  143.           After you have selected the door listing you wish to modify,
  144.           that line of your SFDOOR.MNU will be displayed to the screen.
  145.           
  146.           You are then prompted with:
  147.          
  148.           Do you wish to continue? [y/N]
  149.          
  150.           N will return you to the menu, Y will allow you to make 
  151.           changes to the listing selected.
  152.          
  153.           From this point, changing a door listing is very similar
  154.           to adding a new door listing.  You are prompted to enter
  155.           the door title, the security access of G, L or E (as
  156.           described above) and the security that will be assigned
  157.           to the door.  Again, when you have completed your modifications
  158.           SFDOOR will display a reminder that your SF.BAT may need to
  159.           be modified.
  160.  
  161.     <D>.............Delete A Door Listing
  162.  
  163.        When you select this option, SFDOOR will display the following
  164.        prompt:
  165.          
  166.        Delete which door listing? [A B C D E F]
  167.          
  168.        where [A B C D E F] represents the list of doors and your selection
  169.        should correspond to the door you wish to delete.  [A B C D E F]
  170.        is variable according to the number of doors you have available
  171.        on your system.  If you have the maximum number of doors this 
  172.        would range from A to Z, with the exception of G and Q.
  173.          
  174.        After you have selected the door listing you wish to delete, that
  175.        line of your SFDOOR.MNU will be displayed to the screen.
  176.           
  177.        You are then prompted with:
  178.          
  179.        Do you wish to continue? [y/N]
  180.          
  181.        N will return you to the menu, Y will remove that line from the
  182.        door listing of SFDOOR.MNU, thus, deleting the door.
  183.  
  184.        SFDOOR will also provide the following prompt:
  185.          
  186.        Your SF.BAT file will probably 
  187.        need to be altered accordingly!
  188.          
  189.        This is extremely important when deleting a door!  When a line
  190.        is deleted from SFDOOR.MNU, the lines that follow are now each
  191.        associated with a new letter.  Therefore, the letter associated
  192.        with each door no longer corresponds to the letter previously
  193.        associated with that particular door.
  194.        
  195.        As an example, let's assume a board has 3 doors; A, B and C.
  196.        If door B is deleted when the changes are saved, the listing is 
  197.        removed from SFDOOR.MNU and what was door C now becomes door B.
  198.        
  199.        Therefore, it becomes extremely important to ensure your SF.BAT
  200.        commands correspond to the appropriate door.
  201.        
  202.     
  203.     <R>...............Review SFDOOR.MNU
  204.  
  205.        Selecting this option, will display the contents of the SFDOOR.MNU
  206.        file.  If you have made any changes since beginning SFDOOR, those
  207.        changes will also be displayed, even though the changes have not
  208.        been saved.  When reviewing the SFDOOR.MNU, if you have a large
  209.        number of doors, the screen will fill and you are prompted to
  210.        Press your favorite key to continue..., to continue reviewing the
  211.        remainder of the list.  After the entire door listing has displayed
  212.        you are again be prompted with, Press your favorite key to 
  213.        continue..., which will return you to the SFDOOR menu.
  214.  
  215.     <S>.................Save SFDOOR.MNU
  216.  
  217.        Selecting this option, will save the SFDOOR.MNU file. However,
  218.        if you attempt to quit without saving your changes, SFDOOR
  219.        will prompt you to save the modifications you have made.
  220.         
  221.  
  222.     <Q>..............................Quit
  223.        
  224.        Selecting this option, returns you to the DOS prompt.  If you
  225.        have selected Quit, after making changes to your SFDOOR.MNU
  226.        file and not saved the changes, SFDOOR will prompt you with:
  227.        
  228.        Save changes? [Y/n]
  229.        
  230.        Selecting "y" will allow the modifications made to the SFDOOR.MNU
  231.        file to be saved prior to returning to DOS.  Selecting "n" ignores
  232.        any changes made and simply returns you to the DOS prompt.
  233.  
  234.        Pressing the ESC key will produce the same results as selecting
  235.        <Q> to Quit.  If you have made changes, you will be prompted
  236.        as to whether the changes should be saved and if no changes have
  237.        been made, you are simply returned to the DOS prompt.
  238.  
  239.     
  240.     DISTRIBUTION
  241.     ------------
  242.  
  243.        SFDOOR is distributed under the shareware concept.  You are
  244.     free to distribute the SFDOOR program as long as it remains
  245.     unmodified and no fee is charged.  If you continue to use this 
  246.     program after an adequate evaluation period a fee is required.
  247.     A $1.00 fee is required of register SFDOOR.
  248.  
  249.  
  250.     DISCLAIMER
  251.     ----------
  252.         
  253.        Mike Woltz and/or Buffalo Creek Software shall in no way be 
  254.     held responsible for any damage incurred while operating SFDOOR.
  255.     All responsibility lies with the user of the software.
  256.  
  257.        The documentation for SFDOOR is contributed by Jacque
  258.     Shipley and The Mother Board BBS.  The shareware version of
  259.     SPITFIRE and other SPITFIRE utilities are available for download
  260.     from:
  261.  
  262.          Buffalo Creek's BBS              The Mother Board BBS
  263.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  264.            (515) 225-8496                    (515) 986-3464
  265.     38400/19200/9600/2400/1200 Baud      19200/9600/2400/1200 Baud
  266.